<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.telemetry.service.client;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.StringReader;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.Date;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.logging.Logger;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    import javax.xml.bind.JAXBContext;<a name="line.7"></a>
<FONT color="green">008</FONT>    import javax.xml.bind.Unmarshaller;<a name="line.8"></a>
<FONT color="green">009</FONT>    import javax.xml.datatype.XMLGregorianCalendar;<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>    import org.hackystat.telemetry.service.resource.chart.jaxb.TelemetryChartDefinition;<a name="line.11"></a>
<FONT color="green">012</FONT>    import org.hackystat.telemetry.service.resource.chart.jaxb.TelemetryChartIndex;<a name="line.12"></a>
<FONT color="green">013</FONT>    import org.hackystat.telemetry.service.resource.chart.jaxb.TelemetryChartData;<a name="line.13"></a>
<FONT color="green">014</FONT>    import org.hackystat.telemetry.service.resource.chart.jaxb.TelemetryPoint;<a name="line.14"></a>
<FONT color="green">015</FONT>    import org.hackystat.telemetry.service.resource.chart.jaxb.TelemetryStream;<a name="line.15"></a>
<FONT color="green">016</FONT>    import org.hackystat.utilities.logger.HackystatLogger;<a name="line.16"></a>
<FONT color="green">017</FONT>    import org.restlet.Client;<a name="line.17"></a>
<FONT color="green">018</FONT>    import org.restlet.data.ChallengeResponse;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.restlet.data.ChallengeScheme;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.restlet.data.MediaType;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.restlet.data.Method;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.restlet.data.Preference;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.restlet.data.Protocol;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.restlet.data.Reference;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.restlet.data.Request;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.restlet.data.Response;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.restlet.data.Status;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.restlet.resource.Representation;<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>    /**<a name="line.30"></a>
<FONT color="green">031</FONT>     * Provides a client to support access to the DailyProjectData service. <a name="line.31"></a>
<FONT color="green">032</FONT>     * @author Philip Johnson<a name="line.32"></a>
<FONT color="green">033</FONT>     */<a name="line.33"></a>
<FONT color="green">034</FONT>    public class TelemetryClient {<a name="line.34"></a>
<FONT color="green">035</FONT>      <a name="line.35"></a>
<FONT color="green">036</FONT>      /** Holds the userEmail to be associated with this client. */<a name="line.36"></a>
<FONT color="green">037</FONT>      private String userEmail;<a name="line.37"></a>
<FONT color="green">038</FONT>      /** Holds the password to be associated with this client. */<a name="line.38"></a>
<FONT color="green">039</FONT>      private String password;<a name="line.39"></a>
<FONT color="green">040</FONT>      /** The Telemetry host, such as "http://localhost:9878/telemetry". */<a name="line.40"></a>
<FONT color="green">041</FONT>      private String telemetryHost;<a name="line.41"></a>
<FONT color="green">042</FONT>      /** The Restlet Client instance used to communicate with the server. */<a name="line.42"></a>
<FONT color="green">043</FONT>      private Client client;<a name="line.43"></a>
<FONT color="green">044</FONT>      /** Chart JAXBContext. */<a name="line.44"></a>
<FONT color="green">045</FONT>      private JAXBContext chartJAXB;<a name="line.45"></a>
<FONT color="green">046</FONT>      /** The http authentication approach. */<a name="line.46"></a>
<FONT color="green">047</FONT>      private ChallengeScheme scheme = ChallengeScheme.HTTP_BASIC;<a name="line.47"></a>
<FONT color="green">048</FONT>      /** The preferred representation type. */<a name="line.48"></a>
<FONT color="green">049</FONT>      private Preference&lt;MediaType&gt; xmlMedia = new Preference&lt;MediaType&gt;(MediaType.TEXT_XML);<a name="line.49"></a>
<FONT color="green">050</FONT>      /** To facilitate debugging of problems using this system. */<a name="line.50"></a>
<FONT color="green">051</FONT>      private boolean isTraceEnabled = false;<a name="line.51"></a>
<FONT color="green">052</FONT>      /** The logger for telemetry client information. */<a name="line.52"></a>
<FONT color="green">053</FONT>      private Logger logger;<a name="line.53"></a>
<FONT color="green">054</FONT>      /** The System property key used to retrieve the default timeout value in milliseconds. */<a name="line.54"></a>
<FONT color="green">055</FONT>      public static final String TELEMETRYCLIENT_TIMEOUT_KEY = "telemetryclient.timeout";<a name="line.55"></a>
<FONT color="green">056</FONT>      /** Required by PMD. */<a name="line.56"></a>
<FONT color="green">057</FONT>      private static final String cache = "cache/";<a name="line.57"></a>
<FONT color="green">058</FONT>      /** Required by PMD. */<a name="line.58"></a>
<FONT color="green">059</FONT>      private String space = " : ";<a name="line.59"></a>
<FONT color="green">060</FONT>      <a name="line.60"></a>
<FONT color="green">061</FONT>      /**<a name="line.61"></a>
<FONT color="green">062</FONT>       * Initializes a new TelemetryClient, given the host, userEmail, and password. <a name="line.62"></a>
<FONT color="green">063</FONT>       * Note that the userEmail and password refer to the underlying SensorBase client<a name="line.63"></a>
<FONT color="green">064</FONT>       * associated with this Telemetry service.  This service does not keep its own<a name="line.64"></a>
<FONT color="green">065</FONT>       * independent set of userEmails and passwords.  Authentication is not actually performed<a name="line.65"></a>
<FONT color="green">066</FONT>       * in this constructor. Use the authenticate() method to explicitly check the authentication<a name="line.66"></a>
<FONT color="green">067</FONT>       * credentials. <a name="line.67"></a>
<FONT color="green">068</FONT>       * @param host The host, such as 'http://localhost:9878/telemetry'.<a name="line.68"></a>
<FONT color="green">069</FONT>       * @param email The user's email used for authentication. <a name="line.69"></a>
<FONT color="green">070</FONT>       * @param password The password used for authentication.<a name="line.70"></a>
<FONT color="green">071</FONT>       */<a name="line.71"></a>
<FONT color="green">072</FONT>      public TelemetryClient(String host, String email, String password) {<a name="line.72"></a>
<FONT color="green">073</FONT>        this.logger = HackystatLogger.getLogger(<a name="line.73"></a>
<FONT color="green">074</FONT>            "org.hackystat.telemetry.service.client.TelemetryClient", "telemetry", false);<a name="line.74"></a>
<FONT color="green">075</FONT>        this.logger.info("Instantiating client for: " + host + " " + email);<a name="line.75"></a>
<FONT color="green">076</FONT>        validateArg(host);<a name="line.76"></a>
<FONT color="green">077</FONT>        validateArg(email);<a name="line.77"></a>
<FONT color="green">078</FONT>        validateArg(password);<a name="line.78"></a>
<FONT color="green">079</FONT>        this.userEmail = email;<a name="line.79"></a>
<FONT color="green">080</FONT>        this.password = password;<a name="line.80"></a>
<FONT color="green">081</FONT>        this.telemetryHost = host;<a name="line.81"></a>
<FONT color="green">082</FONT>        if (!this.telemetryHost.endsWith("/")) {<a name="line.82"></a>
<FONT color="green">083</FONT>          this.telemetryHost = this.telemetryHost + "/";<a name="line.83"></a>
<FONT color="green">084</FONT>        }<a name="line.84"></a>
<FONT color="green">085</FONT>        if (this.isTraceEnabled) {<a name="line.85"></a>
<FONT color="green">086</FONT>          System.out.println("TelemetryClient Tracing: INITIALIZE " + <a name="line.86"></a>
<FONT color="green">087</FONT>              "host='" + host + "', email='" + email + "', password='" + password + "'");<a name="line.87"></a>
<FONT color="green">088</FONT>        }<a name="line.88"></a>
<FONT color="green">089</FONT>        this.client = new Client(Protocol.HTTP);<a name="line.89"></a>
<FONT color="green">090</FONT>        setTimeoutFromSystemProperty();<a name="line.90"></a>
<FONT color="green">091</FONT>        try {<a name="line.91"></a>
<FONT color="green">092</FONT>          this.chartJAXB = <a name="line.92"></a>
<FONT color="green">093</FONT>            JAXBContext.newInstance(<a name="line.93"></a>
<FONT color="green">094</FONT>                org.hackystat.telemetry.service.resource.chart.jaxb.ObjectFactory.class);<a name="line.94"></a>
<FONT color="green">095</FONT>        }<a name="line.95"></a>
<FONT color="green">096</FONT>        catch (Exception e) {<a name="line.96"></a>
<FONT color="green">097</FONT>          throw new RuntimeException("Couldn't create JAXB context instances.", e);<a name="line.97"></a>
<FONT color="green">098</FONT>        }<a name="line.98"></a>
<FONT color="green">099</FONT>      }<a name="line.99"></a>
<FONT color="green">100</FONT>      <a name="line.100"></a>
<FONT color="green">101</FONT>      /**<a name="line.101"></a>
<FONT color="green">102</FONT>       * Throws an unchecked illegal argument exception if the arg is null or empty. <a name="line.102"></a>
<FONT color="green">103</FONT>       * @param arg The String that must be non-null and non-empty. <a name="line.103"></a>
<FONT color="green">104</FONT>       */<a name="line.104"></a>
<FONT color="green">105</FONT>      private void validateArg(String arg) {<a name="line.105"></a>
<FONT color="green">106</FONT>        if ((arg == null) || ("".equals(arg))) {<a name="line.106"></a>
<FONT color="green">107</FONT>          throw new IllegalArgumentException(arg + " cannot be null or the empty string.");<a name="line.107"></a>
<FONT color="green">108</FONT>        }<a name="line.108"></a>
<FONT color="green">109</FONT>      }<a name="line.109"></a>
<FONT color="green">110</FONT>      <a name="line.110"></a>
<FONT color="green">111</FONT>      <a name="line.111"></a>
<FONT color="green">112</FONT>      /**<a name="line.112"></a>
<FONT color="green">113</FONT>       * Sets the timeout for this client if the system property telemetryclient.timeout is set<a name="line.113"></a>
<FONT color="green">114</FONT>       * and if it can be parsed to an integer.<a name="line.114"></a>
<FONT color="green">115</FONT>       */<a name="line.115"></a>
<FONT color="green">116</FONT>      private void setTimeoutFromSystemProperty() {<a name="line.116"></a>
<FONT color="green">117</FONT>        String systemTimeout = System.getProperty(TELEMETRYCLIENT_TIMEOUT_KEY);<a name="line.117"></a>
<FONT color="green">118</FONT>        // if not set, then return immediately.<a name="line.118"></a>
<FONT color="green">119</FONT>        if (systemTimeout == null) {<a name="line.119"></a>
<FONT color="green">120</FONT>          return;<a name="line.120"></a>
<FONT color="green">121</FONT>        }<a name="line.121"></a>
<FONT color="green">122</FONT>        // systemTimeout has a value, so set it if we can.<a name="line.122"></a>
<FONT color="green">123</FONT>        try {<a name="line.123"></a>
<FONT color="green">124</FONT>          int timeout = Integer.parseInt(systemTimeout);<a name="line.124"></a>
<FONT color="green">125</FONT>          setTimeout(timeout);<a name="line.125"></a>
<FONT color="green">126</FONT>          this.logger.info("TelemetryClient timeout set to: " + timeout + " milliseconds");<a name="line.126"></a>
<FONT color="green">127</FONT>        }<a name="line.127"></a>
<FONT color="green">128</FONT>        catch (Exception e) {<a name="line.128"></a>
<FONT color="green">129</FONT>          this.logger.warning("telemetryclient.timeout has non integer value: " + systemTimeout);<a name="line.129"></a>
<FONT color="green">130</FONT>        }<a name="line.130"></a>
<FONT color="green">131</FONT>      }<a name="line.131"></a>
<FONT color="green">132</FONT>      <a name="line.132"></a>
<FONT color="green">133</FONT>      /**<a name="line.133"></a>
<FONT color="green">134</FONT>       * Sets the timeout value for this client.<a name="line.134"></a>
<FONT color="green">135</FONT>       * <a name="line.135"></a>
<FONT color="green">136</FONT>       * @param milliseconds The number of milliseconds to wait before timing out.<a name="line.136"></a>
<FONT color="green">137</FONT>       */<a name="line.137"></a>
<FONT color="green">138</FONT>      public final synchronized void setTimeout(int milliseconds) {<a name="line.138"></a>
<FONT color="green">139</FONT>        client.getContext().getParameters().removeAll("connectTimeout");<a name="line.139"></a>
<FONT color="green">140</FONT>        client.getContext().getParameters().add("connectTimeout", String.valueOf(milliseconds));<a name="line.140"></a>
<FONT color="green">141</FONT>        // For the Apache Commons client.<a name="line.141"></a>
<FONT color="green">142</FONT>        client.getContext().getParameters().removeAll("readTimeout");<a name="line.142"></a>
<FONT color="green">143</FONT>        client.getContext().getParameters().add("readTimeout", String.valueOf(milliseconds));<a name="line.143"></a>
<FONT color="green">144</FONT>        client.getContext().getParameters().removeAll("connectionManagerTimeout");<a name="line.144"></a>
<FONT color="green">145</FONT>        client.getContext().getParameters().add("connectionManagerTimeout",<a name="line.145"></a>
<FONT color="green">146</FONT>            String.valueOf(milliseconds));<a name="line.146"></a>
<FONT color="green">147</FONT>      }<a name="line.147"></a>
<FONT color="green">148</FONT>    <a name="line.148"></a>
<FONT color="green">149</FONT>      <a name="line.149"></a>
<FONT color="green">150</FONT>      /**<a name="line.150"></a>
<FONT color="green">151</FONT>       * Does the housekeeping for making HTTP requests to the SensorBase by a test or admin user. <a name="line.151"></a>
<FONT color="green">152</FONT>       * @param method The type of Method.<a name="line.152"></a>
<FONT color="green">153</FONT>       * @param requestString A string, such as "users". No preceding slash. <a name="line.153"></a>
<FONT color="green">154</FONT>       * @param entity The representation to be sent with the request, or null if not needed.  <a name="line.154"></a>
<FONT color="green">155</FONT>       * @return The Response instance returned from the server.<a name="line.155"></a>
<FONT color="green">156</FONT>       */<a name="line.156"></a>
<FONT color="green">157</FONT>      private Response makeRequest(Method method, String requestString, Representation entity) {<a name="line.157"></a>
<FONT color="green">158</FONT>        Reference reference = new Reference(this.telemetryHost + requestString);<a name="line.158"></a>
<FONT color="green">159</FONT>        Request request = (entity == null) ? <a name="line.159"></a>
<FONT color="green">160</FONT>            new Request(method, reference) :<a name="line.160"></a>
<FONT color="green">161</FONT>              new Request(method, reference, entity);<a name="line.161"></a>
<FONT color="green">162</FONT>        request.getClientInfo().getAcceptedMediaTypes().add(xmlMedia); <a name="line.162"></a>
<FONT color="green">163</FONT>        ChallengeResponse authentication = new ChallengeResponse(scheme, this.userEmail, this.password);<a name="line.163"></a>
<FONT color="green">164</FONT>        request.setChallengeResponse(authentication);<a name="line.164"></a>
<FONT color="green">165</FONT>        if (this.isTraceEnabled) {<a name="line.165"></a>
<FONT color="green">166</FONT>          System.out.println("TelemetryClient Tracing: " + method + " " + reference);<a name="line.166"></a>
<FONT color="green">167</FONT>          if (entity != null) {<a name="line.167"></a>
<FONT color="green">168</FONT>            try {<a name="line.168"></a>
<FONT color="green">169</FONT>              System.out.println(entity.getText());<a name="line.169"></a>
<FONT color="green">170</FONT>            }<a name="line.170"></a>
<FONT color="green">171</FONT>            catch (Exception e) {<a name="line.171"></a>
<FONT color="green">172</FONT>              System.out.println("  Problems with getText() on entity.");<a name="line.172"></a>
<FONT color="green">173</FONT>            }<a name="line.173"></a>
<FONT color="green">174</FONT>          }<a name="line.174"></a>
<FONT color="green">175</FONT>        }<a name="line.175"></a>
<FONT color="green">176</FONT>        Response response = this.client.handle(request);<a name="line.176"></a>
<FONT color="green">177</FONT>        if (this.isTraceEnabled) {<a name="line.177"></a>
<FONT color="green">178</FONT>          Status status = response.getStatus();<a name="line.178"></a>
<FONT color="green">179</FONT>          System.out.println("  =&gt; " + status.getCode() + " " + status.getDescription());<a name="line.179"></a>
<FONT color="green">180</FONT>        }<a name="line.180"></a>
<FONT color="green">181</FONT>        return response;<a name="line.181"></a>
<FONT color="green">182</FONT>      }<a name="line.182"></a>
<FONT color="green">183</FONT>      <a name="line.183"></a>
<FONT color="green">184</FONT>      /**<a name="line.184"></a>
<FONT color="green">185</FONT>       * Takes a String encoding of a TelemetryChart in XML format and converts it. <a name="line.185"></a>
<FONT color="green">186</FONT>       * @param xmlString The XML string representing a TelemetryChart.<a name="line.186"></a>
<FONT color="green">187</FONT>       * @return The corresponding TelemetryChart instance. <a name="line.187"></a>
<FONT color="green">188</FONT>       * @throws Exception If problems occur during unmarshalling.<a name="line.188"></a>
<FONT color="green">189</FONT>       */<a name="line.189"></a>
<FONT color="green">190</FONT>      private TelemetryChartData makeChart(String xmlString) throws Exception {<a name="line.190"></a>
<FONT color="green">191</FONT>        Unmarshaller unmarshaller = this.chartJAXB.createUnmarshaller();<a name="line.191"></a>
<FONT color="green">192</FONT>        return (TelemetryChartData)unmarshaller.unmarshal(new StringReader(xmlString));<a name="line.192"></a>
<FONT color="green">193</FONT>      }<a name="line.193"></a>
<FONT color="green">194</FONT>      <a name="line.194"></a>
<FONT color="green">195</FONT>      /**<a name="line.195"></a>
<FONT color="green">196</FONT>       * Takes a String encoding of a TelemetryChartIndex in XML format and converts it. <a name="line.196"></a>
<FONT color="green">197</FONT>       * @param xmlString The XML string representing a TelemetryChartIndex.<a name="line.197"></a>
<FONT color="green">198</FONT>       * @return The corresponding TelemetryChartIndex instance. <a name="line.198"></a>
<FONT color="green">199</FONT>       * @throws Exception If problems occur during unmarshalling.<a name="line.199"></a>
<FONT color="green">200</FONT>       */<a name="line.200"></a>
<FONT color="green">201</FONT>      private TelemetryChartIndex makeChartIndex(String xmlString) throws Exception {<a name="line.201"></a>
<FONT color="green">202</FONT>        Unmarshaller unmarshaller = this.chartJAXB.createUnmarshaller();<a name="line.202"></a>
<FONT color="green">203</FONT>        return (TelemetryChartIndex)unmarshaller.unmarshal(new StringReader(xmlString));<a name="line.203"></a>
<FONT color="green">204</FONT>      }<a name="line.204"></a>
<FONT color="green">205</FONT>      <a name="line.205"></a>
<FONT color="green">206</FONT>      /**<a name="line.206"></a>
<FONT color="green">207</FONT>       * Takes a String encoding of a TelemetryChartDefinition in XML format and converts it. <a name="line.207"></a>
<FONT color="green">208</FONT>       * @param xmlString The XML string representing a TelemetryChartDefinition.<a name="line.208"></a>
<FONT color="green">209</FONT>       * @return The corresponding TelemetryChartDefinition instance. <a name="line.209"></a>
<FONT color="green">210</FONT>       * @throws Exception If problems occur during unmarshalling.<a name="line.210"></a>
<FONT color="green">211</FONT>       */<a name="line.211"></a>
<FONT color="green">212</FONT>      private TelemetryChartDefinition makeChartDefinition(String xmlString) throws Exception {<a name="line.212"></a>
<FONT color="green">213</FONT>        Unmarshaller unmarshaller = this.chartJAXB.createUnmarshaller();<a name="line.213"></a>
<FONT color="green">214</FONT>        return (TelemetryChartDefinition)unmarshaller.unmarshal(new StringReader(xmlString));<a name="line.214"></a>
<FONT color="green">215</FONT>      }<a name="line.215"></a>
<FONT color="green">216</FONT>      <a name="line.216"></a>
<FONT color="green">217</FONT>      /**<a name="line.217"></a>
<FONT color="green">218</FONT>       * Authenticates this user and password with this Telemetry service, throwing a<a name="line.218"></a>
<FONT color="green">219</FONT>       * TelemetryClientException if the user and password associated with this instance<a name="line.219"></a>
<FONT color="green">220</FONT>       * are not valid credentials. <a name="line.220"></a>
<FONT color="green">221</FONT>       * Note that authentication is performed by checking these credentials with the underlying<a name="line.221"></a>
<FONT color="green">222</FONT>       * SensorBase; this service does not keep its own independent set of usernames and passwords.<a name="line.222"></a>
<FONT color="green">223</FONT>       * @return This TelemetryClient instance. <a name="line.223"></a>
<FONT color="green">224</FONT>       * @throws TelemetryClientException If authentication is not successful. <a name="line.224"></a>
<FONT color="green">225</FONT>       */<a name="line.225"></a>
<FONT color="green">226</FONT>      public synchronized TelemetryClient authenticate() throws TelemetryClientException {<a name="line.226"></a>
<FONT color="green">227</FONT>        // Performs authentication by invoking ping with user and password as form params.<a name="line.227"></a>
<FONT color="green">228</FONT>        String uri = "ping?user=" + this.userEmail + "&amp;password=" + this.password;<a name="line.228"></a>
<FONT color="green">229</FONT>        Response response = makeRequest(Method.GET, uri, null); <a name="line.229"></a>
<FONT color="green">230</FONT>        if (!response.getStatus().isSuccess()) {<a name="line.230"></a>
<FONT color="green">231</FONT>          throw new TelemetryClientException(response.getStatus());<a name="line.231"></a>
<FONT color="green">232</FONT>        }<a name="line.232"></a>
<FONT color="green">233</FONT>        String responseString;<a name="line.233"></a>
<FONT color="green">234</FONT>        try {<a name="line.234"></a>
<FONT color="green">235</FONT>          responseString = response.getEntity().getText();<a name="line.235"></a>
<FONT color="green">236</FONT>        }<a name="line.236"></a>
<FONT color="green">237</FONT>        catch (Exception e) {<a name="line.237"></a>
<FONT color="green">238</FONT>          throw new TelemetryClientException("Bad response", e);<a name="line.238"></a>
<FONT color="green">239</FONT>        }<a name="line.239"></a>
<FONT color="green">240</FONT>        if (!"Telemetry authenticated".equals(responseString)) {<a name="line.240"></a>
<FONT color="green">241</FONT>          throw new TelemetryClientException("Authentication failed");<a name="line.241"></a>
<FONT color="green">242</FONT>        }<a name="line.242"></a>
<FONT color="green">243</FONT>        return this;<a name="line.243"></a>
<FONT color="green">244</FONT>      }<a name="line.244"></a>
<FONT color="green">245</FONT>      <a name="line.245"></a>
<FONT color="green">246</FONT>      /**<a name="line.246"></a>
<FONT color="green">247</FONT>       * Returns a TelemetryChart instance from this server, or throws a<a name="line.247"></a>
<FONT color="green">248</FONT>       * TelemetryClientException if problems occur.  <a name="line.248"></a>
<FONT color="green">249</FONT>       * @param name The chart name.<a name="line.249"></a>
<FONT color="green">250</FONT>       * @param user The user email.<a name="line.250"></a>
<FONT color="green">251</FONT>       * @param project The project.<a name="line.251"></a>
<FONT color="green">252</FONT>       * @param granularity Either Day, Week, or Month.<a name="line.252"></a>
<FONT color="green">253</FONT>       * @param start The start day.<a name="line.253"></a>
<FONT color="green">254</FONT>       * @param end The end day.<a name="line.254"></a>
<FONT color="green">255</FONT>       * @return The TelemetryChart instance. <a name="line.255"></a>
<FONT color="green">256</FONT>       * @throws TelemetryClientException If the credentials associated with this instance<a name="line.256"></a>
<FONT color="green">257</FONT>       * are not valid, or if the underlying SensorBase service cannot be reached, or if one or more<a name="line.257"></a>
<FONT color="green">258</FONT>       * of the supplied user, password, or timestamp is not valid.<a name="line.258"></a>
<FONT color="green">259</FONT>       */<a name="line.259"></a>
<FONT color="green">260</FONT>      public synchronized TelemetryChartData getChart(String name, String user, String project, <a name="line.260"></a>
<FONT color="green">261</FONT>          String granularity, XMLGregorianCalendar start, XMLGregorianCalendar end) <a name="line.261"></a>
<FONT color="green">262</FONT>      throws TelemetryClientException {<a name="line.262"></a>
<FONT color="green">263</FONT>        return getChart(name, user, project, granularity, start, end, null);<a name="line.263"></a>
<FONT color="green">264</FONT>      } <a name="line.264"></a>
<FONT color="green">265</FONT>      <a name="line.265"></a>
<FONT color="green">266</FONT>      /**<a name="line.266"></a>
<FONT color="green">267</FONT>       * Returns a TelemetryChart instance from this server, or throws a<a name="line.267"></a>
<FONT color="green">268</FONT>       * TelemetryClientException if problems occur.  <a name="line.268"></a>
<FONT color="green">269</FONT>       * @param name The chart name.<a name="line.269"></a>
<FONT color="green">270</FONT>       * @param user The user email.<a name="line.270"></a>
<FONT color="green">271</FONT>       * @param project The project.<a name="line.271"></a>
<FONT color="green">272</FONT>       * @param granularity Either Day, Week, or Month.<a name="line.272"></a>
<FONT color="green">273</FONT>       * @param start The start day.<a name="line.273"></a>
<FONT color="green">274</FONT>       * @param end The end day.<a name="line.274"></a>
<FONT color="green">275</FONT>       * @param params The parameter string, or null if no params are present.<a name="line.275"></a>
<FONT color="green">276</FONT>       * @return The TelemetryChart instance. <a name="line.276"></a>
<FONT color="green">277</FONT>       * @throws TelemetryClientException If the credentials associated with this instance<a name="line.277"></a>
<FONT color="green">278</FONT>       * are not valid, or if the underlying SensorBase service cannot be reached, or if one or more<a name="line.278"></a>
<FONT color="green">279</FONT>       * of the supplied user, password, or timestamp is not valid.<a name="line.279"></a>
<FONT color="green">280</FONT>       */<a name="line.280"></a>
<FONT color="green">281</FONT>      public synchronized TelemetryChartData getChart(String name, String user, String project, <a name="line.281"></a>
<FONT color="green">282</FONT>          String granularity, XMLGregorianCalendar start, XMLGregorianCalendar end, String params) <a name="line.282"></a>
<FONT color="green">283</FONT>      throws TelemetryClientException {<a name="line.283"></a>
<FONT color="green">284</FONT>        long startTime = (new Date()).getTime();<a name="line.284"></a>
<FONT color="green">285</FONT>        String uri = <a name="line.285"></a>
<FONT color="green">286</FONT>          "chart/" + name + "/" + user + "/" + project + "/" + granularity + "/" + start + "/" + end +<a name="line.286"></a>
<FONT color="green">287</FONT>          ((params == null) ? "" : "?params=" + params);<a name="line.287"></a>
<FONT color="green">288</FONT>        Response response = makeRequest(Method.GET,  uri, null);<a name="line.288"></a>
<FONT color="green">289</FONT>        TelemetryChartData chart;<a name="line.289"></a>
<FONT color="green">290</FONT>        if (!response.getStatus().isSuccess()) {<a name="line.290"></a>
<FONT color="green">291</FONT>          String msg = response.getStatus().getDescription() + space + uri;<a name="line.291"></a>
<FONT color="green">292</FONT>          logElapsedTime(msg, startTime);<a name="line.292"></a>
<FONT color="green">293</FONT>          throw new TelemetryClientException(response.getStatus());<a name="line.293"></a>
<FONT color="green">294</FONT>        }<a name="line.294"></a>
<FONT color="green">295</FONT>        try {<a name="line.295"></a>
<FONT color="green">296</FONT>          String xmlData = response.getEntity().getText();<a name="line.296"></a>
<FONT color="green">297</FONT>          chart = makeChart(xmlData);<a name="line.297"></a>
<FONT color="green">298</FONT>        }<a name="line.298"></a>
<FONT color="green">299</FONT>        catch (Exception e) {<a name="line.299"></a>
<FONT color="green">300</FONT>          logElapsedTime(uri, startTime, e);<a name="line.300"></a>
<FONT color="green">301</FONT>          throw new TelemetryClientException(response.getStatus(), e);<a name="line.301"></a>
<FONT color="green">302</FONT>        }<a name="line.302"></a>
<FONT color="green">303</FONT>        logElapsedTime(uri, startTime);<a name="line.303"></a>
<FONT color="green">304</FONT>        return chart;<a name="line.304"></a>
<FONT color="green">305</FONT>      }<a name="line.305"></a>
<FONT color="green">306</FONT>      <a name="line.306"></a>
<FONT color="green">307</FONT>      /**<a name="line.307"></a>
<FONT color="green">308</FONT>       * Clears the DailyProjectData cache associated with this user in the Telemetry service <a name="line.308"></a>
<FONT color="green">309</FONT>       * associated with this TelemetryClient.<a name="line.309"></a>
<FONT color="green">310</FONT>       * @throws TelemetryClientException If problems occur. <a name="line.310"></a>
<FONT color="green">311</FONT>       */<a name="line.311"></a>
<FONT color="green">312</FONT>      public synchronized void clearServerCache() throws TelemetryClientException {<a name="line.312"></a>
<FONT color="green">313</FONT>        long startTime = (new Date()).getTime();<a name="line.313"></a>
<FONT color="green">314</FONT>        String uri = cache;<a name="line.314"></a>
<FONT color="green">315</FONT>        Response response = makeRequest(Method.DELETE,  uri, null);<a name="line.315"></a>
<FONT color="green">316</FONT>        if (!response.getStatus().isSuccess()) {<a name="line.316"></a>
<FONT color="green">317</FONT>          String msg = response.getStatus().getDescription() + space + uri;<a name="line.317"></a>
<FONT color="green">318</FONT>          logElapsedTime(msg, startTime);<a name="line.318"></a>
<FONT color="green">319</FONT>          throw new TelemetryClientException(response.getStatus());<a name="line.319"></a>
<FONT color="green">320</FONT>        }<a name="line.320"></a>
<FONT color="green">321</FONT>      }<a name="line.321"></a>
<FONT color="green">322</FONT>      <a name="line.322"></a>
<FONT color="green">323</FONT>      /**<a name="line.323"></a>
<FONT color="green">324</FONT>       * Clears the DailyProjectData cache entries for this user that are associated with the passed <a name="line.324"></a>
<FONT color="green">325</FONT>       * project and its owner in the Telemetry service associated with this TelemetryClient.<a name="line.325"></a>
<FONT color="green">326</FONT>       * @param project The project to be cleared. <a name="line.326"></a>
<FONT color="green">327</FONT>       * @param owner The owner of the project. <a name="line.327"></a>
<FONT color="green">328</FONT>       * @throws TelemetryClientException If problems occur. <a name="line.328"></a>
<FONT color="green">329</FONT>       */<a name="line.329"></a>
<FONT color="green">330</FONT>      public synchronized void clearServerCache(String owner, String project) <a name="line.330"></a>
<FONT color="green">331</FONT>      throws TelemetryClientException {<a name="line.331"></a>
<FONT color="green">332</FONT>        long startTime = (new Date()).getTime();<a name="line.332"></a>
<FONT color="green">333</FONT>        String uri = cache + owner + "/" + project;<a name="line.333"></a>
<FONT color="green">334</FONT>        Response response = makeRequest(Method.DELETE,  uri, null);<a name="line.334"></a>
<FONT color="green">335</FONT>        if (!response.getStatus().isSuccess()) {<a name="line.335"></a>
<FONT color="green">336</FONT>          String msg = response.getStatus().getDescription() + space + uri;<a name="line.336"></a>
<FONT color="green">337</FONT>          logElapsedTime(msg, startTime);<a name="line.337"></a>
<FONT color="green">338</FONT>          throw new TelemetryClientException(response.getStatus());<a name="line.338"></a>
<FONT color="green">339</FONT>        }<a name="line.339"></a>
<FONT color="green">340</FONT>      }<a name="line.340"></a>
<FONT color="green">341</FONT>      <a name="line.341"></a>
<FONT color="green">342</FONT>      /**<a name="line.342"></a>
<FONT color="green">343</FONT>       * Returns a TelemetryChartIndex instance from this server, or throws a<a name="line.343"></a>
<FONT color="green">344</FONT>       * TelemetryClientException if problems occur.  <a name="line.344"></a>
<FONT color="green">345</FONT>       * @return The TelemetryChartIndex instance. <a name="line.345"></a>
<FONT color="green">346</FONT>       * @throws TelemetryClientException If the credentials associated with this instance<a name="line.346"></a>
<FONT color="green">347</FONT>       * are not valid, or if the underlying SensorBase service cannot be reached, or if one or more<a name="line.347"></a>
<FONT color="green">348</FONT>       * of the supplied user, password, or timestamp is not valid.<a name="line.348"></a>
<FONT color="green">349</FONT>       */<a name="line.349"></a>
<FONT color="green">350</FONT>      public synchronized TelemetryChartIndex getChartIndex() throws TelemetryClientException {<a name="line.350"></a>
<FONT color="green">351</FONT>        long startTime = (new Date()).getTime();<a name="line.351"></a>
<FONT color="green">352</FONT>        String uri = "charts";<a name="line.352"></a>
<FONT color="green">353</FONT>        Response response = makeRequest(Method.GET,  uri, null);<a name="line.353"></a>
<FONT color="green">354</FONT>        TelemetryChartIndex index;<a name="line.354"></a>
<FONT color="green">355</FONT>        if (!response.getStatus().isSuccess()) {<a name="line.355"></a>
<FONT color="green">356</FONT>          String msg = response.getStatus().getDescription() + space + uri;<a name="line.356"></a>
<FONT color="green">357</FONT>          logElapsedTime(msg, startTime);<a name="line.357"></a>
<FONT color="green">358</FONT>          throw new TelemetryClientException(response.getStatus());<a name="line.358"></a>
<FONT color="green">359</FONT>        }<a name="line.359"></a>
<FONT color="green">360</FONT>        try {<a name="line.360"></a>
<FONT color="green">361</FONT>          String xmlData = response.getEntity().getText();<a name="line.361"></a>
<FONT color="green">362</FONT>          index = makeChartIndex(xmlData);<a name="line.362"></a>
<FONT color="green">363</FONT>        }<a name="line.363"></a>
<FONT color="green">364</FONT>        catch (Exception e) {<a name="line.364"></a>
<FONT color="green">365</FONT>          logElapsedTime(uri, startTime, e);<a name="line.365"></a>
<FONT color="green">366</FONT>          throw new TelemetryClientException(response.getStatus(), e);<a name="line.366"></a>
<FONT color="green">367</FONT>        }<a name="line.367"></a>
<FONT color="green">368</FONT>        logElapsedTime(uri, startTime);<a name="line.368"></a>
<FONT color="green">369</FONT>        return index;<a name="line.369"></a>
<FONT color="green">370</FONT>      } <a name="line.370"></a>
<FONT color="green">371</FONT>      <a name="line.371"></a>
<FONT color="green">372</FONT>      /**<a name="line.372"></a>
<FONT color="green">373</FONT>       * Returns a TelemetryChartDefinition instance from this server, or throws a<a name="line.373"></a>
<FONT color="green">374</FONT>       * TelemetryClientException if problems occur.  <a name="line.374"></a>
<FONT color="green">375</FONT>       * <a name="line.375"></a>
<FONT color="green">376</FONT>       * @param chartName The name of the chart whose definition is to be retrieved.<a name="line.376"></a>
<FONT color="green">377</FONT>       * @return The TelemetryChartDefinition instance. <a name="line.377"></a>
<FONT color="green">378</FONT>       * @throws TelemetryClientException If the credentials associated with this instance<a name="line.378"></a>
<FONT color="green">379</FONT>       * are not valid, or if the underlying SensorBase service cannot be reached, or if one or more<a name="line.379"></a>
<FONT color="green">380</FONT>       * of the supplied user, password, or timestamp is not valid.<a name="line.380"></a>
<FONT color="green">381</FONT>       */<a name="line.381"></a>
<FONT color="green">382</FONT>      public synchronized TelemetryChartDefinition getChartDefinition(String chartName) <a name="line.382"></a>
<FONT color="green">383</FONT>      throws TelemetryClientException {<a name="line.383"></a>
<FONT color="green">384</FONT>        long startTime = (new Date()).getTime();<a name="line.384"></a>
<FONT color="green">385</FONT>        String uri = "chart/" + chartName;<a name="line.385"></a>
<FONT color="green">386</FONT>        Response response = makeRequest(Method.GET,  uri, null);<a name="line.386"></a>
<FONT color="green">387</FONT>        TelemetryChartDefinition chartDef;<a name="line.387"></a>
<FONT color="green">388</FONT>        if (!response.getStatus().isSuccess()) {<a name="line.388"></a>
<FONT color="green">389</FONT>          String msg = response.getStatus().getDescription() + space + uri;<a name="line.389"></a>
<FONT color="green">390</FONT>          logElapsedTime(msg, startTime);<a name="line.390"></a>
<FONT color="green">391</FONT>          throw new TelemetryClientException(response.getStatus());<a name="line.391"></a>
<FONT color="green">392</FONT>        }<a name="line.392"></a>
<FONT color="green">393</FONT>        try {<a name="line.393"></a>
<FONT color="green">394</FONT>          String xmlData = response.getEntity().getText();<a name="line.394"></a>
<FONT color="green">395</FONT>          chartDef = makeChartDefinition(xmlData);<a name="line.395"></a>
<FONT color="green">396</FONT>        }<a name="line.396"></a>
<FONT color="green">397</FONT>        catch (Exception e) {<a name="line.397"></a>
<FONT color="green">398</FONT>          logElapsedTime(uri, startTime, e);<a name="line.398"></a>
<FONT color="green">399</FONT>          throw new TelemetryClientException(response.getStatus(), e);<a name="line.399"></a>
<FONT color="green">400</FONT>        }<a name="line.400"></a>
<FONT color="green">401</FONT>        logElapsedTime(uri, startTime);<a name="line.401"></a>
<FONT color="green">402</FONT>        return chartDef;<a name="line.402"></a>
<FONT color="green">403</FONT>      } <a name="line.403"></a>
<FONT color="green">404</FONT>      <a name="line.404"></a>
<FONT color="green">405</FONT>      /**<a name="line.405"></a>
<FONT color="green">406</FONT>       * Returns true if the passed host is a Telemetry host. <a name="line.406"></a>
<FONT color="green">407</FONT>       * @param host The URL of a Telemetry host, "http://localhost:9875/telemetry".<a name="line.407"></a>
<FONT color="green">408</FONT>       * @return True if this URL responds as a Telemetry host. <a name="line.408"></a>
<FONT color="green">409</FONT>       */<a name="line.409"></a>
<FONT color="green">410</FONT>      public static boolean isHost(String host) {<a name="line.410"></a>
<FONT color="green">411</FONT>        // All sensorbase hosts use the HTTP protocol.<a name="line.411"></a>
<FONT color="green">412</FONT>        if (!host.startsWith("http://")) {<a name="line.412"></a>
<FONT color="green">413</FONT>          return false;<a name="line.413"></a>
<FONT color="green">414</FONT>        }<a name="line.414"></a>
<FONT color="green">415</FONT>        // Create the host/register URL.<a name="line.415"></a>
<FONT color="green">416</FONT>        try {<a name="line.416"></a>
<FONT color="green">417</FONT>          String registerUri = host.endsWith("/") ? host + "ping" : host + "/ping"; <a name="line.417"></a>
<FONT color="green">418</FONT>          Request request = new Request();<a name="line.418"></a>
<FONT color="green">419</FONT>          request.setResourceRef(registerUri);<a name="line.419"></a>
<FONT color="green">420</FONT>          request.setMethod(Method.GET);<a name="line.420"></a>
<FONT color="green">421</FONT>          Client client = new Client(Protocol.HTTP);<a name="line.421"></a>
<FONT color="green">422</FONT>          Response response = client.handle(request);<a name="line.422"></a>
<FONT color="green">423</FONT>          String pingText = response.getEntity().getText();<a name="line.423"></a>
<FONT color="green">424</FONT>          return (response.getStatus().isSuccess() &amp;&amp; "Telemetry".equals(pingText));<a name="line.424"></a>
<FONT color="green">425</FONT>        }<a name="line.425"></a>
<FONT color="green">426</FONT>        catch (Exception e) {<a name="line.426"></a>
<FONT color="green">427</FONT>          return false;<a name="line.427"></a>
<FONT color="green">428</FONT>        }<a name="line.428"></a>
<FONT color="green">429</FONT>      }<a name="line.429"></a>
<FONT color="green">430</FONT>    <a name="line.430"></a>
<FONT color="green">431</FONT>      /**<a name="line.431"></a>
<FONT color="green">432</FONT>       * Returns the host associated with this Telemetry client. <a name="line.432"></a>
<FONT color="green">433</FONT>       * @return The host.<a name="line.433"></a>
<FONT color="green">434</FONT>       */<a name="line.434"></a>
<FONT color="green">435</FONT>      public String getHostName() {<a name="line.435"></a>
<FONT color="green">436</FONT>        return this.telemetryHost;<a name="line.436"></a>
<FONT color="green">437</FONT>      }<a name="line.437"></a>
<FONT color="green">438</FONT>      <a name="line.438"></a>
<FONT color="green">439</FONT>      /**<a name="line.439"></a>
<FONT color="green">440</FONT>       * Returns the passed telemetry chart data in a human-readable string.<a name="line.440"></a>
<FONT color="green">441</FONT>       * For debugging purposes, this method is expensive. <a name="line.441"></a>
<FONT color="green">442</FONT>       * @param chart The chart data.<a name="line.442"></a>
<FONT color="green">443</FONT>       * @return The chart data, as a string.<a name="line.443"></a>
<FONT color="green">444</FONT>       */<a name="line.444"></a>
<FONT color="green">445</FONT>      public static String toString(TelemetryChartData chart) {<a name="line.445"></a>
<FONT color="green">446</FONT>        StringBuilder toString = new StringBuilder();<a name="line.446"></a>
<FONT color="green">447</FONT>        toString.append("Telemetry Chart Data : ");<a name="line.447"></a>
<FONT color="green">448</FONT>        toString.append(chart.getURI()); <a name="line.448"></a>
<FONT color="green">449</FONT>        for (TelemetryStream stream : chart.getTelemetryStream()) {<a name="line.449"></a>
<FONT color="green">450</FONT>          toString.append("\n ");<a name="line.450"></a>
<FONT color="green">451</FONT>          toString.append(stream.getName());<a name="line.451"></a>
<FONT color="green">452</FONT>          for (TelemetryPoint point : stream.getTelemetryPoint()) {<a name="line.452"></a>
<FONT color="green">453</FONT>            toString.append("   ");<a name="line.453"></a>
<FONT color="green">454</FONT>            toString.append(point.getValue());<a name="line.454"></a>
<FONT color="green">455</FONT>          }<a name="line.455"></a>
<FONT color="green">456</FONT>        }<a name="line.456"></a>
<FONT color="green">457</FONT>        return toString.toString();<a name="line.457"></a>
<FONT color="green">458</FONT>      }<a name="line.458"></a>
<FONT color="green">459</FONT>      <a name="line.459"></a>
<FONT color="green">460</FONT>      /**<a name="line.460"></a>
<FONT color="green">461</FONT>       * Logs info to the logger about the elapsed time for this request. <a name="line.461"></a>
<FONT color="green">462</FONT>       * @param uri The URI requested.<a name="line.462"></a>
<FONT color="green">463</FONT>       * @param startTime The startTime of the call.<a name="line.463"></a>
<FONT color="green">464</FONT>       * @param e The exception thrown, or null if no exception. <a name="line.464"></a>
<FONT color="green">465</FONT>       */<a name="line.465"></a>
<FONT color="green">466</FONT>      private void logElapsedTime (String uri, long startTime, Exception e) {<a name="line.466"></a>
<FONT color="green">467</FONT>        long millis = (new Date()).getTime() - startTime;<a name="line.467"></a>
<FONT color="green">468</FONT>        String msg = millis + " millis: " + uri + ((e == null) ? "" : " " + e);<a name="line.468"></a>
<FONT color="green">469</FONT>        this.logger.info(msg);<a name="line.469"></a>
<FONT color="green">470</FONT>      }<a name="line.470"></a>
<FONT color="green">471</FONT>      <a name="line.471"></a>
<FONT color="green">472</FONT>      /**<a name="line.472"></a>
<FONT color="green">473</FONT>       * Logs info to the logger about the elapsed time for this request. <a name="line.473"></a>
<FONT color="green">474</FONT>       * @param uri The URI requested.<a name="line.474"></a>
<FONT color="green">475</FONT>       * @param startTime The startTime of the call.<a name="line.475"></a>
<FONT color="green">476</FONT>       */<a name="line.476"></a>
<FONT color="green">477</FONT>      private void logElapsedTime (String uri, long startTime) {<a name="line.477"></a>
<FONT color="green">478</FONT>        logElapsedTime(uri, startTime, null);<a name="line.478"></a>
<FONT color="green">479</FONT>      }<a name="line.479"></a>
<FONT color="green">480</FONT>    <a name="line.480"></a>
<FONT color="green">481</FONT>    }<a name="line.481"></a>




























































</PRE>
</BODY>
</HTML>
